Transaction

The Transaction element contains all pertinent information for a transaction, such as amounts, dates, customer information, and credit card information.

Parameter

Description

TransactionId

The ID of the transaction. This should be stored if you are going to capture/cancel the order directly from your system, for example, for capturing reservations using the captureReservation method.

PaymentId

The ID of a payment or subscription. Is used for transaction processing.

AuthType

The authorisation type of the payment, for example, "payment"/"paymentAndCapture"/"subscription"

CardStatus

The status of the credit card: 

  • NoCreditCard
  • InvalidLuhn
  • InvalidCardLength
  • SoonExpired
  • Expired
  • Valid
  • DeletedPan

CreditCardExpiry

The year and month when the credit card expires.

  • Year
  • Month

CreditCardToken

This is the unique credit card token value that identifies a credit card within the AltaPay Payment Gateway. This token can be used later with the Merchant API or with creditcard token ordering so that the customer does not need to enter credit card details in their next order. The token is only returned for credit card payments.

CreditCardMaskedPan

The masked primary account number of the credit card, which contains the maximum number of digits allowed to share with a non-PCI compliant merchant.

IsTokenized

Boolean value indicating if the transaction uses a tokenized card.

CardInformation

Contains card related information

  • IsTokenized: Boolean value indicating if the transaction used a tokenized card.
  • Token: This is the unique credit card token value that identifies a credit card within the AltaPay Payment Gateway. This token can be used later with the Merchant API or with creditcard token ordering so that the customer does not need to enter credit card details in their next order. The token is only returned for credit card payments.
  • MaskedPan: The masked primary account number of the credit card, which contains the maximum number of digits allowed to share with a non-PCI compliant merchant.
  • Expiry: The year and month when the credit card expires.
    <Expiry>
        <Year>2026</Year>
        <Month>05</Month>
    </Expiry>
                                                                                
  • IssuingCountry: A valid 2 character ISO-3166 country code of the country where the card was issued. Ex: US
  • LastFourDigits: The last 4 digits of the card number.
  • Scheme: The card scheme. Ex: VISA

GiftCardToken

The gift card token.

MaskedGiftCard

The masked gift card number.

ThreeDSecureResult

The result of a 3D Secure verification using the verify3dSecure method.Not_ApplicableDisabled Not_Attempted CardType_Not_SupportedNot_EnrolledDeclinedErrorAttemptedSuccessful

LiableForChargeback

The party liable for chargebacks, most often the merchant.

CVVCheckResult

The result of a CVV verification:

  • Not_Applicable
  • Not_Attempted
  • Unknown
  • Matched
  • MisMatched

BlacklistToken

A unique token you can use for blacklisting a credit card. This token can be used to build up a black list of credit cards. The token is only returned if this is a credit card payment.

ShopOrderId

The ID of the order in your shop.

Shop

The name of the shop.

Terminal

The name of the terminal.

TransactionStatus

The status of the transaction, depending on the payment method, for example, preauth,recurring_confirmed, captured, etc.

If you need a complete list of transaction statuses, please request it by contacting support@altapay.com.

ReasonCode

A reason code related to the current TransactionStatus, for example:

  • OPEN_WAITING_FOR_ACQUIRER
  • NONE

CardHolderMessageMustBeShown

An indicator on whether the card holder error message must be shown to your customer.

MerchantCurrency

The ISO-4217 three digit currency code.

MerchantCurrencyAlpha

The ISO-4217 three letter currency code

CardHolderCurrency

The ISO-4217 three digit currency code.

CardHolderCurrencyAlpha

The ISO-4217 three letter currency code

ReservedAmount

The reserved amount.

CapturedAmount

The captured amount.

RefundedAmount

The refunded amount.

CreditedAmount

The credited amount.

RecurringDefaultAmount

The default amount for recurring payments.

SurchargeAmount

The surcharge amount applied to the transaction.

CreatedDate

The date the transaction was first created.

UpdatedDate

The date the transaction was last updated.

PaymentNature

The payment method:

  • Wallet
  • EPayment
  • CreditCard
  • BankPayment
  • IdealPayment
  • Invoice
  • CreditCardWallet
  • GiftCard
  • Mobile

PaymentSchemeName

The name of the payment scheme, for example, Dankort or Visa.

PaymentNatureService

The supported services for the payment method, for example:

  • <SupportsRefunds>true</SupportsRefunds>
  • <SupportsRelease >true</SupportsRelease >
  • <SupportsMultipleCaptures >true</SupportsMultipleCaptures >
  • <SupportsMultipleRefunds>true</SupportsMultipleRefunds>

FraudRiskScore

This is the probability that the transaction is a fraud attempt, and should be read in context of the FraudExplanation and the FraudRecommendation. For example a fraud risk score of 13.37 means there is a 13.37% chance of this order being fraud. Only MaxMind utilizes the fraud score. For ReD, the value is always -1.

FraudExplanation

Contains a detailed explanation of the fraud risk evaluation. Only relevant for MaxMind. For ReD it contains the value of the recommendation.

FraudRecommendation

The recommendation from the fraud detection service provider. For example:

  • Accept: The order does not appear to be fraudulent, and you should deliver the goods or services.
  • Deny: The order appears to be fraudulent, and you should not deliver the goods or services.
  • Challenge: Something about the order is questionable. You should review the order manually before making a decision. For ReD, Challenge is only supported for bespoke setups. If you are using the ReD Sector model, Challenge is not available.
  • Unknown: There is no recommendation available, either because of insufficient information, or an underlying service was unavailable, for example, there was no response from ReD.
  • Unknown is also returned for declined transaction.

AddressVerification

The address verification result code. For more information, see Address verification parameters.

AddressVerificationDescription

The description of the address verification result code. For more information, see Address verification parameters.

ChargebackEvents

Contains an array of Chargeback elements, each with information about that specific chargeback event:

  • Date
  • Type
  • ReasonCode
  • Reason
  • Amount
  • Currency
  • AcquirerTransactionId
  • AdditionalInfo

PaymentInfos

Contains an array of custom payment information, for example:

<PaymentInfos>
	<PaymentInfo name="Form_Created_At">2010-09-28 12:34:56</PaymentInfo>
	<PaymentInfo name="Form_Provider">AltaPay Test Form</PaymentInfo>
	<PaymentInfo name="Merchant_Provided_Info">Some info by merchant</PaymentInfo>
</PaymentInfos>

CustomerInfo

Contains information about the customer:

  • UserAgent, for example, Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/535.7 (KHTML, like Gecko) Chrome/16.0.912.41 Safari/535.7
  • IpAddress
  • Email
  • Username
  • CustomerPhone
  • OrganisationNumber
  • CountryOfOrigin
    • Country
    • Source
      • NotSet

      • CardNumber

      • BankAccount

      • BillingAddress

      • RegisteredAddress

      • ShippingAddress

      • PayPal

  • Gender
    • M
    • F
  • BillingAddress. See Address.
  • ShippingAddress. See Address.
  • RegisteredAddress. See Address.

ReconciliationIdentifiers

Contains a set of ReconciliationIdentifier elements, each with information about

  • Id
  • Amount, with the currency as an attribute, for example: <Amount currency="EUR">1.0</Amount>
  • Type
  • Date